<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2012 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: PersistentObjectSchemaUpdater.html 973 2015-04-22 14:58:55Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.pobj;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.IOException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.util.HashSet;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.util.List;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.util.Set;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import javax.validation.ConstraintViolation;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import javax.xml.namespace.QName;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import javax.xml.stream.XMLOutputFactory;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import javax.xml.stream.XMLStreamWriter;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import javax.xml.transform.Result;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import javax.xml.transform.Source;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import javax.xml.transform.TransformerFactory;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import javax.xml.transform.dom.DOMSource;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import javax.xml.transform.stax.StAXResult;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import javax.xml.transform.stream.StreamResult;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.dellroad.stuff.schema.AbstractSchemaUpdater;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.dellroad.stuff.schema.UnrecognizedUpdateException;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * A {@link PersistentObjectDelegate} that is also a {@link AbstractSchemaUpdater} that automatically<a name="line.30"></a>
<span class="sourceLineNo">031</span> * applies needed updates to the persistent XML file.<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;p&gt;<a name="line.33"></a>
<span class="sourceLineNo">034</span> * To use this class, wrap your normal delegate in an instance of this class. This will augment<a name="line.34"></a>
<span class="sourceLineNo">035</span> * the serialization and deserialization process to keep track of which updates have been applied to the XML structure,<a name="line.35"></a>
<span class="sourceLineNo">036</span> * and automatically and transparently apply any needed updates during deserialization.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;/p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Updates are tracked by inserting an &lt;code&gt;{@link #UPDATES_ELEMENT_NAME &amp;lt;pobj:updates&amp;gt;}&lt;/code&gt; element<a name="line.40"></a>
<span class="sourceLineNo">041</span> * into the serialized XML document; this update list is transparently removed when the document is read back,<a name="line.41"></a>
<span class="sourceLineNo">042</span> * and any missing updates are applied automatically.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * In this way the document and its set of applied updates always travel together. For example:<a name="line.43"></a>
<span class="sourceLineNo">044</span> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;blockquote&gt;&lt;pre&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> *  &amp;lt;MyConfig&amp;gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> *      &lt;b&gt;&amp;lt;pobj:updates xmlns:pobj="http://dellroad-stuff.googlecode.com/ns/persistentObject"&amp;gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> *          &amp;lt;pobj:update&gt;some-update-name-1&amp;lt;/pobj:update&amp;gt;<a name="line.48"></a>
<span class="sourceLineNo">049</span> *          &amp;lt;pobj:update&gt;some-update-name-2&amp;lt;/pobj:update&amp;gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> *      &amp;lt;/pobj:updates&amp;gt;&lt;/b&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> *      &amp;lt;username&amp;gt;admin&amp;lt;/username&amp;gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> *      &amp;lt;password&amp;gt;secret&amp;lt;/password&amp;gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> *  &amp;lt;/MyConfig&amp;gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;/pre&gt;&lt;/blockquote&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;/p&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> *<a name="line.56"></a>
<span class="sourceLineNo">057</span> * &lt;p&gt;<a name="line.57"></a>
<span class="sourceLineNo">058</span> * For Spring applications, {@link SpringPersistentObjectSchemaUpdater} provides a convenient declarative way<a name="line.58"></a>
<span class="sourceLineNo">059</span> * to define your schema updates via XSLT files.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * &lt;/p&gt;<a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> * @param &lt;T&gt; type of the root persistent object<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span>public class PersistentObjectSchemaUpdater&lt;T&gt; extends AbstractSchemaUpdater&lt;PersistentFileTransaction, PersistentFileTransaction&gt;<a name="line.64"></a>
<span class="sourceLineNo">065</span>  implements PersistentObjectDelegate&lt;T&gt; {<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>    /**<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * XML namespace URI used for nested update elements.<a name="line.68"></a>
<span class="sourceLineNo">069</span>     */<a name="line.69"></a>
<span class="sourceLineNo">070</span>    public static final String NAMESPACE_URI = "http://dellroad-stuff.googlecode.com/ns/persistentObject";<a name="line.70"></a>
<span class="sourceLineNo">071</span><a name="line.71"></a>
<span class="sourceLineNo">072</span>    /**<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * Preferred XML namespace prefix for {@link #NAMESPACE_URI} elements.<a name="line.73"></a>
<span class="sourceLineNo">074</span>     */<a name="line.74"></a>
<span class="sourceLineNo">075</span>    public static final String XML_PREFIX = "pobj";<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    /**<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * XML element name for the updates list.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     */<a name="line.79"></a>
<span class="sourceLineNo">080</span>    public static final QName UPDATES_ELEMENT_NAME = new QName(NAMESPACE_URI, "updates", XML_PREFIX);<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span>    /**<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * XML element name for a single update.<a name="line.83"></a>
<span class="sourceLineNo">084</span>     */<a name="line.84"></a>
<span class="sourceLineNo">085</span>    public static final QName UPDATE_ELEMENT_NAME = new QName(NAMESPACE_URI, "update", XML_PREFIX);<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    /**<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * XML namespace URI used for namespace declarations.<a name="line.88"></a>
<span class="sourceLineNo">089</span>     */<a name="line.89"></a>
<span class="sourceLineNo">090</span>    public static final QName XMLNS_ATTRIBUTE_NAME = new QName("http://www.w3.org/2000/xmlns/", XML_PREFIX, "xmlns");<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    protected final PersistentObjectDelegate&lt;T&gt; delegate;<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span>    private final XMLOutputFactory xmlOutputFactory = XMLOutputFactory.newFactory();<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>    private List&lt;String&gt; updateNames;<a name="line.96"></a>
<span class="sourceLineNo">097</span>    private TransformerFactory transformerFactory;<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>// Constructors<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span>    /**<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * Constructor.<a name="line.102"></a>
<span class="sourceLineNo">103</span>     *<a name="line.103"></a>
<span class="sourceLineNo">104</span>     * &lt;p&gt;<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * Callers provide a {@link PersistentObjectDelegate} that will be used for all operations, with the exception<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * that {@linkplain #serialize serialization} and {@linkplain #deserialize deserialization} will add/remove<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * the upate list, and {@linkplain #deserialize deserialization} will apply any needed updates as necessary.<a name="line.107"></a>
<span class="sourceLineNo">108</span>     *<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * @param delegate delegate that will be wrapped by this instance<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * @throws IllegalArgumentException if {@code delegate} is null<a name="line.110"></a>
<span class="sourceLineNo">111</span>     */<a name="line.111"></a>
<span class="sourceLineNo">112</span>    public PersistentObjectSchemaUpdater(PersistentObjectDelegate&lt;T&gt; delegate) {<a name="line.112"></a>
<span class="sourceLineNo">113</span>        if (delegate == null)<a name="line.113"></a>
<span class="sourceLineNo">114</span>            throw new IllegalArgumentException("null delegate");<a name="line.114"></a>
<span class="sourceLineNo">115</span>        this.delegate = delegate;<a name="line.115"></a>
<span class="sourceLineNo">116</span>    }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span>// Accessors<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>    /**<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * Configure the {@link TransformerFactory} to be used by this instance when reading the updates from the XML file.<a name="line.121"></a>
<span class="sourceLineNo">122</span>     * Must support reading from a StAX {@link Source}.<a name="line.122"></a>
<span class="sourceLineNo">123</span>     *<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * &lt;p&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * The implementation in {@link PersistentObjectSchemaUpdater} returns null.<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * &lt;/p&gt;<a name="line.126"></a>
<span class="sourceLineNo">127</span>     *<a name="line.127"></a>
<span class="sourceLineNo">128</span>     * @param transformerFactory {@link TransformerFactory} to use or null for the platform default<a name="line.128"></a>
<span class="sourceLineNo">129</span>     */<a name="line.129"></a>
<span class="sourceLineNo">130</span>    public void setTransformerFactory(TransformerFactory transformerFactory) {<a name="line.130"></a>
<span class="sourceLineNo">131</span>        this.transformerFactory = transformerFactory;<a name="line.131"></a>
<span class="sourceLineNo">132</span>    }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span>// PersistentObjectDelegate methods<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span>    /**<a name="line.136"></a>
<span class="sourceLineNo">137</span>     * Make a deep copy of the given object.<a name="line.137"></a>
<span class="sourceLineNo">138</span>     *<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * &lt;p&gt;<a name="line.139"></a>
<span class="sourceLineNo">140</span>     * The implementation in {@link PersistentObjectSchemaUpdater} delegates to the delegate provided in the constructor.<a name="line.140"></a>
<span class="sourceLineNo">141</span>     *<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * @throws IllegalArgumentException {@inheritDoc}<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * @throws PersistentObjectException {@inheritDoc}<a name="line.143"></a>
<span class="sourceLineNo">144</span>     */<a name="line.144"></a>
<span class="sourceLineNo">145</span>    @Override<a name="line.145"></a>
<span class="sourceLineNo">146</span>    public T copy(T original) {<a name="line.146"></a>
<span class="sourceLineNo">147</span>        return this.delegate.copy(original);<a name="line.147"></a>
<span class="sourceLineNo">148</span>    }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span>    /**<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * Compare two object graphs.<a name="line.151"></a>
<span class="sourceLineNo">152</span>     *<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * &lt;p&gt;<a name="line.153"></a>
<span class="sourceLineNo">154</span>     * The implementation in {@link PersistentObjectSchemaUpdater} delegates to the delegate provided in the constructor.<a name="line.154"></a>
<span class="sourceLineNo">155</span>     */<a name="line.155"></a>
<span class="sourceLineNo">156</span>    @Override<a name="line.156"></a>
<span class="sourceLineNo">157</span>    public boolean isSameGraph(T root1, T root2) {<a name="line.157"></a>
<span class="sourceLineNo">158</span>        return this.delegate.isSameGraph(root1, root2);<a name="line.158"></a>
<span class="sourceLineNo">159</span>    }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span>    /**<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * Validate the given instance.<a name="line.162"></a>
<span class="sourceLineNo">163</span>     *<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * &lt;p&gt;<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * The implementation in {@link PersistentObjectSchemaUpdater} delegates to the delegate provided in the constructor.<a name="line.165"></a>
<span class="sourceLineNo">166</span>     *<a name="line.166"></a>
<span class="sourceLineNo">167</span>     * @throws IllegalArgumentException {@inheritDoc}<a name="line.167"></a>
<span class="sourceLineNo">168</span>     */<a name="line.168"></a>
<span class="sourceLineNo">169</span>    @Override<a name="line.169"></a>
<span class="sourceLineNo">170</span>    public Set&lt;ConstraintViolation&lt;T&gt;&gt; validate(T obj) {<a name="line.170"></a>
<span class="sourceLineNo">171</span>        return this.delegate.validate(obj);<a name="line.171"></a>
<span class="sourceLineNo">172</span>    }<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span>    /**<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * Handle an exception thrown during a delayed write-back attempt.<a name="line.175"></a>
<span class="sourceLineNo">176</span>     *<a name="line.176"></a>
<span class="sourceLineNo">177</span>     * &lt;p&gt;<a name="line.177"></a>
<span class="sourceLineNo">178</span>     * The implementation in {@link PersistentObjectSchemaUpdater} delegates to the delegate provided in the constructor.<a name="line.178"></a>
<span class="sourceLineNo">179</span>     */<a name="line.179"></a>
<span class="sourceLineNo">180</span>    @Override<a name="line.180"></a>
<span class="sourceLineNo">181</span>    public void handleWritebackException(PersistentObject&lt;T&gt; pobj, Throwable t) {<a name="line.181"></a>
<span class="sourceLineNo">182</span>        this.delegate.handleWritebackException(pobj, t);<a name="line.182"></a>
<span class="sourceLineNo">183</span>    }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span>    /**<a name="line.185"></a>
<span class="sourceLineNo">186</span>     * Get the default value for the root object graph.<a name="line.186"></a>
<span class="sourceLineNo">187</span>     *<a name="line.187"></a>
<span class="sourceLineNo">188</span>     * &lt;p&gt;<a name="line.188"></a>
<span class="sourceLineNo">189</span>     * The implementation in {@link PersistentObjectSchemaUpdater} delegates to the delegate provided in the constructor.<a name="line.189"></a>
<span class="sourceLineNo">190</span>     */<a name="line.190"></a>
<span class="sourceLineNo">191</span>    @Override<a name="line.191"></a>
<span class="sourceLineNo">192</span>    public T getDefaultValue() {<a name="line.192"></a>
<span class="sourceLineNo">193</span>        return this.delegate.getDefaultValue();<a name="line.193"></a>
<span class="sourceLineNo">194</span>    }<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span>    /**<a name="line.196"></a>
<span class="sourceLineNo">197</span>     * Serialize object to XML.<a name="line.197"></a>
<span class="sourceLineNo">198</span>     *<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * &lt;p&gt;<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * The implementation in {@link PersistentObjectSchemaUpdater} delegates to the delegate provided in the constructor<a name="line.200"></a>
<span class="sourceLineNo">201</span>     * but also adds the update list as the first XML tag.<a name="line.201"></a>
<span class="sourceLineNo">202</span>     *<a name="line.202"></a>
<span class="sourceLineNo">203</span>     * @throws PersistentObjectException {@inheritDoc}<a name="line.203"></a>
<span class="sourceLineNo">204</span>     */<a name="line.204"></a>
<span class="sourceLineNo">205</span>    @Override<a name="line.205"></a>
<span class="sourceLineNo">206</span>    public void serialize(T obj, Result result) throws IOException {<a name="line.206"></a>
<span class="sourceLineNo">207</span>        try {<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span>            // Get update names<a name="line.209"></a>
<span class="sourceLineNo">210</span>            final List&lt;String&gt; updateNameList = this.updateNames != null ? this.updateNames : this.getAllUpdateNames();<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span>            // Wrap result with a writer that adds the update list<a name="line.212"></a>
<span class="sourceLineNo">213</span>            XMLStreamWriter writer;<a name="line.213"></a>
<span class="sourceLineNo">214</span>            if (result instanceof StreamResult &amp;&amp; ((StreamResult)result).getOutputStream() != null)<a name="line.214"></a>
<span class="sourceLineNo">215</span>                writer = this.xmlOutputFactory.createXMLStreamWriter(((StreamResult)result).getOutputStream(), "UTF-8");<a name="line.215"></a>
<span class="sourceLineNo">216</span>            else<a name="line.216"></a>
<span class="sourceLineNo">217</span>                writer = this.xmlOutputFactory.createXMLStreamWriter(result);<a name="line.217"></a>
<span class="sourceLineNo">218</span>            final UpdatesXMLStreamWriter updatesWriter = new UpdatesXMLStreamWriter(writer, updateNameList);<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span>            // Serialize using the provided delegate<a name="line.220"></a>
<span class="sourceLineNo">221</span>            this.delegate.serialize(obj, new StAXResult(updatesWriter));<a name="line.221"></a>
<span class="sourceLineNo">222</span>            updatesWriter.close();<a name="line.222"></a>
<span class="sourceLineNo">223</span>        } catch (RuntimeException e) {<a name="line.223"></a>
<span class="sourceLineNo">224</span>            throw e;<a name="line.224"></a>
<span class="sourceLineNo">225</span>        } catch (IOException e) {<a name="line.225"></a>
<span class="sourceLineNo">226</span>            throw e;<a name="line.226"></a>
<span class="sourceLineNo">227</span>        } catch (Exception e) {<a name="line.227"></a>
<span class="sourceLineNo">228</span>            throw new PersistentObjectException(e);<a name="line.228"></a>
<span class="sourceLineNo">229</span>        }<a name="line.229"></a>
<span class="sourceLineNo">230</span>    }<a name="line.230"></a>
<span class="sourceLineNo">231</span><a name="line.231"></a>
<span class="sourceLineNo">232</span>    /**<a name="line.232"></a>
<span class="sourceLineNo">233</span>     * Deserialize object from XML.<a name="line.233"></a>
<span class="sourceLineNo">234</span>     *<a name="line.234"></a>
<span class="sourceLineNo">235</span>     * &lt;p&gt;<a name="line.235"></a>
<span class="sourceLineNo">236</span>     * The implementation in {@link PersistentObjectSchemaUpdater} delegates to the delegate provided in the constructor<a name="line.236"></a>
<span class="sourceLineNo">237</span>     * but also removes the update list as the first XML tag and applies any needed updates.<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * &lt;/p&gt;<a name="line.238"></a>
<span class="sourceLineNo">239</span>     *<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * @throws PersistentObjectException {@inheritDoc}<a name="line.240"></a>
<span class="sourceLineNo">241</span>     */<a name="line.241"></a>
<span class="sourceLineNo">242</span>    @Override<a name="line.242"></a>
<span class="sourceLineNo">243</span>    public T deserialize(Source source) throws IOException {<a name="line.243"></a>
<span class="sourceLineNo">244</span>        try {<a name="line.244"></a>
<span class="sourceLineNo">245</span><a name="line.245"></a>
<span class="sourceLineNo">246</span>            // Create a temporary in-memory "database" containing the XML content<a name="line.246"></a>
<span class="sourceLineNo">247</span>            PersistentFileTransaction transaction = new PersistentFileTransaction(source, this.transformerFactory);<a name="line.247"></a>
<span class="sourceLineNo">248</span><a name="line.248"></a>
<span class="sourceLineNo">249</span>            // Apply schema updates as necessary to update the XML structure<a name="line.249"></a>
<span class="sourceLineNo">250</span>            this.initializeAndUpdateDatabase(transaction);<a name="line.250"></a>
<span class="sourceLineNo">251</span><a name="line.251"></a>
<span class="sourceLineNo">252</span>            // Save updates names so we can preserve their order<a name="line.252"></a>
<span class="sourceLineNo">253</span>            this.updateNames = transaction.getUpdates();<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span>            // Sanity check that all updates were applied<a name="line.255"></a>
<span class="sourceLineNo">256</span>            final HashSet&lt;String&gt; unappliedUpdates = new HashSet&lt;String&gt;(this.getAllUpdateNames());<a name="line.256"></a>
<span class="sourceLineNo">257</span>            unappliedUpdates.removeAll(this.updateNames);<a name="line.257"></a>
<span class="sourceLineNo">258</span>            if (!unappliedUpdates.isEmpty())<a name="line.258"></a>
<span class="sourceLineNo">259</span>                throw new PersistentObjectException("internal inconsistency: unapplied updates remain: " + unappliedUpdates);<a name="line.259"></a>
<span class="sourceLineNo">260</span><a name="line.260"></a>
<span class="sourceLineNo">261</span>            // Deserialize the now up-to-date XML structure using the provided delegate<a name="line.261"></a>
<span class="sourceLineNo">262</span>            return this.delegate.deserialize(new DOMSource(transaction.getData(), transaction.getSystemId()));<a name="line.262"></a>
<span class="sourceLineNo">263</span>        } catch (UnrecognizedUpdateException e) {<a name="line.263"></a>
<span class="sourceLineNo">264</span>            throw new PersistentObjectException(e);<a name="line.264"></a>
<span class="sourceLineNo">265</span>        } catch (RuntimeException e) {<a name="line.265"></a>
<span class="sourceLineNo">266</span>            throw e;<a name="line.266"></a>
<span class="sourceLineNo">267</span>        } catch (IOException e) {<a name="line.267"></a>
<span class="sourceLineNo">268</span>            throw e;<a name="line.268"></a>
<span class="sourceLineNo">269</span>        } catch (Exception e) {<a name="line.269"></a>
<span class="sourceLineNo">270</span>            throw new PersistentObjectException(e);<a name="line.270"></a>
<span class="sourceLineNo">271</span>        }<a name="line.271"></a>
<span class="sourceLineNo">272</span>    }<a name="line.272"></a>
<span class="sourceLineNo">273</span><a name="line.273"></a>
<span class="sourceLineNo">274</span>// AbstractSchemaUpdater methods<a name="line.274"></a>
<span class="sourceLineNo">275</span><a name="line.275"></a>
<span class="sourceLineNo">276</span>    @Override<a name="line.276"></a>
<span class="sourceLineNo">277</span>    protected boolean databaseNeedsInitialization(PersistentFileTransaction transaction) throws Exception {<a name="line.277"></a>
<span class="sourceLineNo">278</span>        return false;<a name="line.278"></a>
<span class="sourceLineNo">279</span>    }<a name="line.279"></a>
<span class="sourceLineNo">280</span><a name="line.280"></a>
<span class="sourceLineNo">281</span>    @Override<a name="line.281"></a>
<span class="sourceLineNo">282</span>    protected void initializeDatabase(PersistentFileTransaction transaction) throws Exception {<a name="line.282"></a>
<span class="sourceLineNo">283</span>        throw new UnsupportedOperationException();<a name="line.283"></a>
<span class="sourceLineNo">284</span>    }<a name="line.284"></a>
<span class="sourceLineNo">285</span><a name="line.285"></a>
<span class="sourceLineNo">286</span>    @Override<a name="line.286"></a>
<span class="sourceLineNo">287</span>    protected PersistentFileTransaction openTransaction(PersistentFileTransaction transaction) throws Exception {<a name="line.287"></a>
<span class="sourceLineNo">288</span>        return transaction;<a name="line.288"></a>
<span class="sourceLineNo">289</span>    }<a name="line.289"></a>
<span class="sourceLineNo">290</span><a name="line.290"></a>
<span class="sourceLineNo">291</span>    @Override<a name="line.291"></a>
<span class="sourceLineNo">292</span>    protected void commitTransaction(PersistentFileTransaction transaction) throws Exception {<a name="line.292"></a>
<span class="sourceLineNo">293</span>        // nothing to do<a name="line.293"></a>
<span class="sourceLineNo">294</span>    }<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span>    @Override<a name="line.296"></a>
<span class="sourceLineNo">297</span>    protected void rollbackTransaction(PersistentFileTransaction transaction) throws Exception {<a name="line.297"></a>
<span class="sourceLineNo">298</span>        // nothing to do<a name="line.298"></a>
<span class="sourceLineNo">299</span>    }<a name="line.299"></a>
<span class="sourceLineNo">300</span><a name="line.300"></a>
<span class="sourceLineNo">301</span>    @Override<a name="line.301"></a>
<span class="sourceLineNo">302</span>    protected Set&lt;String&gt; getAppliedUpdateNames(PersistentFileTransaction transaction) throws Exception {<a name="line.302"></a>
<span class="sourceLineNo">303</span>        return new HashSet&lt;String&gt;(transaction.getUpdates());<a name="line.303"></a>
<span class="sourceLineNo">304</span>    }<a name="line.304"></a>
<span class="sourceLineNo">305</span><a name="line.305"></a>
<span class="sourceLineNo">306</span>    @Override<a name="line.306"></a>
<span class="sourceLineNo">307</span>    protected void recordUpdateApplied(PersistentFileTransaction transaction, String name) throws Exception {<a name="line.307"></a>
<span class="sourceLineNo">308</span>        transaction.getUpdates().add(name);<a name="line.308"></a>
<span class="sourceLineNo">309</span>    }<a name="line.309"></a>
<span class="sourceLineNo">310</span>}<a name="line.310"></a>
<span class="sourceLineNo">311</span><a name="line.311"></a>




























































</pre>
</div>
</body>
</html>
